Datasette Documentation

Total Page:16

File Type:pdf, Size:1020Kb

Datasette Documentation Datasette Documentation Simon Willison Sep 22, 2021 Contents 1 Contents 3 1.1 Getting started..............................................3 1.1.1 Play with a live demo......................................3 1.1.2 Try Datasette without installing anything using Glitch.....................3 1.1.3 Using Datasette on your own computer............................4 1.1.4 datasette –get..........................................5 1.1.5 datasette serve –help......................................6 1.2 Installation................................................7 1.2.1 Basic installation........................................7 1.2.2 Advanced installation options.................................8 1.3 The Datasette Ecosystem......................................... 10 1.3.1 sqlite-utils............................................ 11 1.3.2 Dogsheep............................................ 11 1.4 Pages and API endpoints......................................... 11 1.4.1 Top-level index......................................... 11 1.4.2 Database............................................ 12 1.4.3 Table.............................................. 12 1.4.4 Row............................................... 12 1.5 Publishing data.............................................. 13 1.5.1 datasette publish........................................ 13 1.5.2 datasette package........................................ 16 1.6 Deploying Datasette........................................... 17 1.6.1 Deployment fundamentals................................... 18 1.6.2 Running Datasette using systemd................................ 18 1.6.3 Deploying using buildpacks.................................. 19 1.6.4 Running Datasette behind a proxy............................... 20 1.7 JSON API................................................ 21 1.7.1 Different shapes......................................... 21 1.7.2 Pagination............................................ 23 1.7.3 Special JSON arguments.................................... 24 1.7.4 Table arguments......................................... 24 1.7.5 Expanding foreign key references............................... 27 1.8 Running SQL queries.......................................... 27 1.8.1 Named parameters....................................... 28 1.8.2 Views.............................................. 28 1.8.3 Canned queries......................................... 28 i 1.8.4 Pagination............................................ 33 1.8.5 Cross-database queries..................................... 34 1.9 Authentication and permissions..................................... 34 1.9.1 Actors.............................................. 34 1.9.2 Permissions........................................... 35 1.9.3 Configuring permissions in metadata.json........................... 37 1.9.4 Checking permissions in plugins................................ 39 1.9.5 actor_matches_allow()..................................... 40 1.9.6 The permissions debug tool................................... 40 1.9.7 The ds_actor cookie....................................... 40 1.9.8 Built-in permissions....................................... 41 1.10 Performance and caching........................................ 42 1.10.1 Immutable mode........................................ 42 1.10.2 Using "datasette inspect".................................... 43 1.10.3 HTTP caching.......................................... 43 1.10.4 Hashed URL mode....................................... 44 1.11 CSV export................................................ 44 1.11.1 URL parameters......................................... 45 1.11.2 Streaming all records...................................... 45 1.11.3 A note on URLs......................................... 45 1.12 Binary data................................................ 45 1.12.1 Linking to binary downloads.................................. 46 1.12.2 Binary plugins......................................... 46 1.13 Facets................................................... 47 1.13.1 Facets in query strings..................................... 47 1.13.2 Facets in metadata.json..................................... 49 1.13.3 Suggested facets........................................ 49 1.13.4 Speeding up facets with indexes................................ 50 1.13.5 Facet by JSON array...................................... 50 1.13.6 Facet by date.......................................... 50 1.14 Full-text search.............................................. 50 1.14.1 The table page and table view API............................... 51 1.14.2 Advanced SQLite search queries................................ 52 1.14.3 Configuring full-text search for a table or view........................ 52 1.14.4 Searches using custom SQL.................................. 52 1.14.5 Enabling full-text search for a SQLite table.......................... 53 1.14.6 FTS versions.......................................... 55 1.15 SpatiaLite................................................. 55 1.15.1 Installation........................................... 55 1.15.2 Spatial indexing latitude/longitude columns.......................... 56 1.15.3 Making use of a spatial index.................................. 56 1.15.4 Importing shapefiles into SpatiaLite.............................. 57 1.15.5 Importing GeoJSON polygons using Shapely......................... 58 1.15.6 Querying polygons using within()............................... 58 1.16 Metadata................................................. 59 1.16.1 Per-database and per-table metadata.............................. 59 1.16.2 Source, license and about.................................... 60 1.16.3 Column descriptions...................................... 60 1.16.4 Specifying units for a column.................................. 61 1.16.5 Setting a default sort order................................... 61 1.16.6 Setting a custom page size................................... 62 1.16.7 Setting which columns can be used for sorting......................... 62 1.16.8 Specifying the label column for a table............................. 63 1.16.9 Hiding tables.......................................... 63 ii 1.16.10 Using YAML for metadata................................... 64 1.17 Settings.................................................. 64 1.17.1 Using –setting.......................................... 64 1.17.2 Configuration directory mode.................................. 64 1.17.3 Settings............................................. 65 1.17.4 Configuring the secret...................................... 69 1.17.5 Using secrets with datasette publish.............................. 70 1.18 Introspection............................................... 70 1.18.1 /-/metadata........................................... 70 1.18.2 /-/versions............................................ 71 1.18.3 /-/plugins............................................ 71 1.18.4 /-/settings............................................ 71 1.18.5 /-/databases........................................... 72 1.18.6 /-/threads............................................ 72 1.18.7 /-/actor.............................................. 73 1.18.8 /-/messages........................................... 73 1.19 Custom pages and templates....................................... 73 1.19.1 Custom CSS and JavaScript.................................. 73 1.19.2 Custom templates........................................ 76 1.19.3 Custom pages.......................................... 78 1.19.4 Custom error pages....................................... 79 1.20 Plugins.................................................. 80 1.20.1 Installing plugins........................................ 80 1.20.2 Seeing what plugins are installed................................ 81 1.20.3 Plugin configuration...................................... 82 1.21 Writing plugins.............................................. 83 1.21.1 Writing one-off plugins..................................... 84 1.21.2 Starting an installable plugin using cookiecutter........................ 84 1.21.3 Packaging a plugin....................................... 84 1.21.4 Static assets........................................... 85 1.21.5 Custom templates........................................ 86 1.21.6 Writing plugins that accept configuration........................... 86 1.21.7 Designing URLs for your plugin................................ 87 1.21.8 Building URLs within plugins................................. 87 1.22 Plugin hooks............................................... 88 1.22.1 prepare_connection(conn, database, datasette)......................... 89 1.22.2 prepare_jinja2_environment(env)................................ 89 1.22.3 extra_template_vars(template, database, table, columns, view_name, request, datasette)... 90 1.22.4 extra_css_urls(template, database, table, columns, view_name, request, datasette)...... 91 1.22.5 extra_js_urls(template, database, table, columns, view_name, request, datasette)....... 92 1.22.6 extra_body_script(template, database, table, columns, view_name, request, datasette).... 92 1.22.7 publish_subcommand(publish)................................. 93 1.22.8 render_cell(value, column, table, database, datasette)..................... 94 1.22.9 register_output_renderer(datasette)............................... 95 1.22.10 register_routes(datasette).................................... 96 1.22.11 register_commands(cli)....................................
Recommended publications
  • Solaris 10 End of Life
    Solaris 10 end of life Continue Oracle Solaris 10 has had an amazing OS update, including ground features such as zones (Solaris containers), FSS, Services, Dynamic Tracking (against live production operating systems without impact), and logical domains. These features have been imitated in the market (imitation is the best form of flattery!) like all good things, they have to come to an end. Sun Microsystems was acquired by Oracle and eventually, the largest OS known to the industry, needs to be updated. Oracle has set a retirement date of January 2021. Oracle indicated that Solaris 10 systems would need to raise support costs. Oracle has never provided migratory tools to facilitate migration from Solaris 10 to Solaris 11, so migration to Solaris has been slow. In September 2019, Oracle decided that extended support for Solaris 10 without an additional financial penalty would be delayed until 2024! Well its March 1 is just a reminder that Oracle Solaris 10 is getting the end of life regarding support if you accept extended support from Oracle. Combined with the fact gdpR should take effect on May 25, 2018 you want to make sure that you are either upgraded to Solaris 11.3 or have taken extended support to obtain any patches for security issues. For more information on tanningix releases and support dates of old and new follow this link ×Sestive to abort the Unix Error Operating System originally developed by Sun Microsystems SolarisDeveloperSun Microsystems (acquired by Oracle Corporation in 2009)Written inC, C'OSUnixWorking StateCurrentSource ModelMixedInitial release1992; 28 years ago (1992-06)Last release11.4 / August 28, 2018; 2 years ago (2018-08-28)Marketing targetServer, PlatformsCurrent: SPARC, x86-64 Former: IA-32, PowerPCKernel typeMonolithic with dynamically downloadable modulesDefault user interface GNOME-2-LicenseVariousOfficial websitewww.oracle.com/solaris Solaris is the own operating system Of Unix, originally developed by Sunsystems.
    [Show full text]
  • Adventures with Illumos
    > Adventures with illumos Peter Tribble Theoretical Astrophysicist Sysadmin (DBA) Technology Tinkerer > Introduction ● Long-time systems administrator ● Many years pointing out bugs in Solaris ● Invited onto beta programs ● Then the OpenSolaris project ● Voted onto OpenSolaris Governing Board ● Along came Oracle... ● illumos emerged from the ashes > key strengths ● ZFS – reliable and easy to manage ● Dtrace – extreme observability ● Zones – lightweight virtualization ● Standards – pretty strict ● Compatibility – decades of heritage ● “Solarishness” > Distributions ● Solaris 11 (OpenSolaris based) ● OpenIndiana – OpenSolaris ● OmniOS – server focus ● SmartOS – Joyent's cloud ● Delphix/Nexenta/+ – storage focus ● Tribblix – one of the small fry ● Quite a few others > Solaris 11 ● IPS packaging ● SPARC and x86 – No 32-bit x86 – No older SPARC (eg Vxxx or SunBlades) ● Unique/key features – Kernel Zones – Encrypted ZFS – VM2 > OpenIndiana ● Direct continuation of OpenSolaris – Warts and all ● IPS packaging ● X86 only (32 and 64 bit) ● General purpose ● JDS desktop ● Generally rather stale > OmniOS ● X86 only ● IPS packaging ● Server focus ● Supported commercial offering ● Stable components can be out of date > XStreamOS ● Modern variant of OpenIndiana ● X86 only ● IPS packaging ● Modern lightweight desktop options ● Extra applications – LibreOffice > SmartOS ● Hypervisor, not general purpose ● 64-bit x86 only ● Basis of Joyent cloud ● No inbuilt packaging, pkgsrc for applications ● Added extra features – KVM guests – Lots of zone features –
    [Show full text]
  • Serdar Temiz
    OPEN DATA AND INNOVATION ADOPTION: Lessons From Sweden Serdar Temiz Doctoral thesis submitted to the School of Industrial Engineering and Management for the fulfillment of the requirements for the degree of Ph.D. in Industrial Engineering and Management KTH Royal Institute of Technology School of Industrial Engineering and Management Department of Industrial Economics and Management SE-10044 Stockholm, Sweden OPEN DATA AND INNOVATION ADOPTION: LESSONS FROM SWEDEN ISBN 978-91-7873-083-4 © Temiz, Serdar, December 2018 [email protected] Academic thesis, with permission and approval of the KTH Royal Institute of Technology, is submitted for public review and doctoral examination in fulfillment of the requirements for the degree of Doctor of Phi- losophy in Industrial Engineering and Management on Monday, February 22, 2019, at 09:00 in Hall F3, Lindstedtsvägen 26, KTH, Stockholm, Sweden. Printed in Sweden, Universitetsservice US-AB ii Abstract The Internet has significantly reduced the cost of producing, accessing, and using data, with governments, companies, open data advocates, and researchers observing open data’s potential for promoting democratic and innovative solutions and with open data’s global market size estimated at billions of dollars in the European Union alone (Carrara, Chan, Fischer, & Steenbergen, 2015). This thesis explores the concept of open data, describing and analyzing how open data adoption occurs to better identify and understand key challenges in this process and thus contribute to better use of the available data resources
    [Show full text]
  • Latest/Contributing.Html 12 13 14
    v0.14+332.gd98c6648.dirty Handbook Introduction • Advanced topics • Use cases ADINA WAGNER &MICHAEL HANKE with Laura Waite, Kyle Meyer, Marisa Heckner, Benjamin Poldrack, Yaroslav Halchenko, Chris Markiewicz, Pattarawat Chormai, Lisa N. Mochalski, Lisa Wiersch, Jean-Baptiste Poline, Nevena Kraljevic, Alex Waite, Lya K. Paas, Niels Reuter, Peter Vavra, Tobias Kadelka, Peer Herholz, Alexandre Hutton, Sarah Oliveira, Dorian Pustina, Hamzah Hamid Baagil, Tristan Glatard, Giulia Ippoliti, Christian Mönch, Togaru Surya Teja, Dorien Huijser, Ariel Rokem, Remi Gau, Judith Bomba, Konrad Hinsen, Wu Jianxiao, Małgorzata Wierzba, Stefan Appelhoff, Michael Joseph, Tamara Cook, Stephan Heunis, Joerg Stadler, Sin Kim, Oscar Esteban CONTENTS I Introduction1 1 A brief overview of DataLad2 1.1 On Data..........................................2 1.2 The DataLad Philosophy.................................3 2 How to use the handbook5 2.1 For whom this book is written..............................5 2.2 How to read this book..................................5 2.3 Let’s get going!......................................8 3 Installation and configuration 10 3.1 Install DataLad...................................... 10 3.2 Initial configuration................................... 17 4 General prerequisites 19 4.1 The Command Line................................... 19 4.2 Command Syntax.................................... 20 4.3 Basic Commands..................................... 20 4.4 The Prompt........................................ 21 4.5 Paths..........................................
    [Show full text]
  • Linux User Group HOWTO Linux User Group HOWTO Table of Contents Linux User Group HOWTO
    Linux User Group HOWTO Linux User Group HOWTO Table of Contents Linux User Group HOWTO..............................................................................................................................1 Rick Moen...............................................................................................................................................1 1. Introduction..........................................................................................................................................1 1.1 Purpose...............................................................................................................................................1 1.2 Other sources of information.............................................................................................................2 2. What is a GNU/Linux user group?......................................................................................................2 2.1 What is GNU/Linux?.........................................................................................................................2 2.2 How is GNU/Linux unique?..............................................................................................................3 2.3 What is a user group?.........................................................................................................................3 2.4 Avoiding Burnout and Decline..........................................................................................................4 2.5 Summary............................................................................................................................................5
    [Show full text]
  • ZFS — and Why You Need It
    ZFS | and why you need it Nelson H. F. Beebe and Pieter J. Bowman University of Utah Department of Mathematics 155 S 1400 E RM 233 Salt Lake City, UT 84112-0090 USA Email: [email protected], [email protected] 10 November 2016 Nelson H. F. Beebe and Pieter J. Bowman Why ZFS? 10 November 2016 1 / 26 What is ZFS? Zettabyte File System (ZFS) developed by Sun Microsystems from 2001 to 2005, with open-source release in 2005 (whence OpenZFS project): SI prefix zetta ≡ 10007 = 1021 Sun Microsystems acquired in 2010 by Oracle [continuing ZFS] ground-up brand-new filesystem design exceptionally clean and well-documented source code enormous capacity 28 ≈ 255 bytes per filename 248 ≈ 1014 files per directory 264 ≈ 1018 bytes per file [1 exabyte] 78 23 1 2 ≈ 10 ≈ 2 Avogadro's number bytes per volume disks form a pool of storage that is always consistent on disk disk blocks in pool allocatable to any filesystem using pool [relatively] simple management optional dynamic quota adjustment ACLs, snapshots, clones, compression, encryption, deduplication, case-[in]sensitive filenames, Unicode filenames, . Nelson H. F. Beebe and Pieter J. Bowman Why ZFS? 10 November 2016 2 / 26 Why use ZFS? ZFS provides a stable flexible filesystem of essentially unlimited capacity [in current technology] for decades to come we have run ZFS under Solaris for 11+ years, with neither data loss, nor filesystem corruption easy to implement n-way live mirroring [n up to 12 (??limit??)] snapshots, even in large filesystems, take only a second or so optional hot spares in each storage pool with ZFS zpool import, a filesystem can be moved to a different server, even one running a different O/S, as long as ZFS feature levels permit ZFS filesystems can be exported via FC, iSCSI, NFS (v2{v4) or SMB/CIFS to other systems, including those without native support for ZFS blocksize can be set in powers-of-two from 29 = 512 to 217 = 128K or with large blocks feature, to 220 = 1M; default on all systems is 128K.
    [Show full text]
  • Physics Computer Lab Manual
    Guide for the Physics Computing Lab (PCL) ∗ Richard Sonnenfeld † September 2011 Revised: August 2007, original version Richard Sonnenfeld February 2008 Jacob Trueblood February 2009 RS and JT September 2011 RS, August 2012 Contents 1 Lab Overview 3 1.1 PhysicsComputingLabGoals. ............ 3 1.1.1 WhyLinux?..................................... ..... 3 1.1.2 HowcanIlearnLinux? ............................ ....... 4 2 Details for Users 4 2.1 Logginginandout................................. ......... 4 2.2 Getting an account and changing your password . ................ 5 2.3 NFS-Mountedhomedirectories . ............. 6 2.4 Printing ........................................ ........ 6 2.5 RemoteAccess .................................... ........ 6 2.6 XwindowsMagic ................................... ........ 6 2.7 X-terminals ..................................... ......... 7 2.8 Backup .......................................... ...... 7 3 Details for new student office computers 7 3.1 BasicInstallationonOfficeComputers . ............... 8 3.2 After the basic installation on Office computers . .................. 9 3.3 Performingbackups ............................... .......... 10 ∗Thanks to Dave Raymond for most of the good ideas for setting up the lab. †Thanks to Victor Alvidrez for lots of hacking and for quick and dirty documentation. 1 4 Installation Details for PCL Administrators 11 4.1 Basicinstallationonclients . ............... 11 4.2 Afterthebasicinstallationonclients . .................. 11 5 System Administration 12 5.1 BurninginstallCDs
    [Show full text]
  • Build Your Own Paas with Docker Table of Contents
    Build Your Own PaaS with Docker Table of Contents Build Your Own PaaS with Docker Credits About the Author About the Reviewers www.PacktPub.com Support files, eBooks, discount offers, and more Why subscribe? Free access for Packt account holders Preface What this book covers What you need for this book Who this book is for Conventions Reader feedback Customer support Downloading the example code Errata Piracy Questions 1. Installing Docker What is Docker? Docker on Ubuntu Trusty 14.04 LTS Upgrading Docker on Ubuntu Trusty 14.04 LTS User permissions Docker on Mac OS X Installation Upgrading Docker on Mac OS X Docker on Windows Installation Upgrading Docker on Windows Docker on Amazon EC2 Installation Open ports Upgrading Docker on Amazon EC2 User permissions Displaying Hello World Summary 2. Exploring Docker The Docker image The Docker container The Docker command-line interface The Docker Registry Hub Browsing repositories Exploring published images Summary 3. Creating Our First PaaS Image The WordPress image Moving from the defaults Our objective Preparing for caching Raising the upload limit Plugin installation Making our changes persist Hosting image sources on GitHub Publishing an image on the Docker Registry Hub Automated builds Summary 4. Giving Containers Data and Parameters Data volumes Mounting a host directory as a data volume Mounting a data volume container Backing up and restoring data volumes Creating a data volume images Data volume image Exposing mount points The Dockerfile Hosting on GitHub Publishing on the Docker Registry Hub Running a data volume container Passing parameters to containers Creating a parameterized image Summary 5.
    [Show full text]
  • ZFS — and Why You Need It
    ZFS | and why you need it Nelson H. F. Beebe and Pieter J. Bowman University of Utah Department of Mathematics 155 S 1400 E RM 233 Salt Lake City, UT 84112-0090 USA Email: [email protected], [email protected] 15 February 2017 Nelson H. F. Beebe and Pieter J. Bowman Why ZFS? 15 February 2017 1 / 26 What is ZFS? Zettabyte File System (ZFS) developed by Sun Microsystems from 2001 to 2005, with open-source release in 2005 (whence OpenZFS project): SI prefix zetta ≡ 10007 = 1021 Sun Microsystems acquired in 2010 by Oracle [continuing ZFS] ground-up brand-new filesystem design exceptionally clean and well-documented source code enormous capacity 28 ≈ 255 bytes per filename 248 ≈ 1014 files per directory 264 ≈ 1018 bytes per file [1 exabyte] 78 23 1 2 ≈ 10 ≈ 2 Avogadro's number bytes per volume disks form a pool of storage that is always consistent on disk disk blocks in pool allocatable to any filesystem using pool [relatively] simple management optional dynamic quota adjustment ACLs, snapshots, clones, compression, encryption, deduplication, case-[in]sensitive filenames, Unicode filenames, . Nelson H. F. Beebe and Pieter J. Bowman Why ZFS? 15 February 2017 2 / 26 Why use ZFS? ZFS provides a stable flexible filesystem of essentially unlimited capacity [in current technology] for decades to come we have run ZFS under Solaris for 11+ years, with neither data loss, nor filesystem corruption easy to implement n-way live mirroring [n up to 12 (??limit??)] snapshots, even in large filesystems, take only a second or so optional hot spares in each storage pool with ZFS zpool import, a filesystem can be moved to a different server, even one running a different O/S, as long as ZFS feature levels permit ZFS filesystems can be exported via FC, iSCSI, NFS (v2{v4) or SMB/CIFS to other systems, including those without native support for ZFS blocksize can be set in powers-of-two from 29 = 512 to 217 = 128K or with large blocks feature, to 220 = 1M; default on all systems is 128K.
    [Show full text]
  • The Multi-Purposes Calibration and Optimization Tool): Un Software Libre Para Obtener Par´Ametros Emp´Iricos Necesarios En Modelos De Simulaci´On
    MPCOTool (the Multi-Purposes Calibration and Optimization Tool): un software libre para obtener par´ametros emp´ıricos necesarios en modelos de simulaci´on Autores del software: J. Burguete y B. Latorre Autor del manual: J. Burguete 8 de diciembre de 2018 ´Indice general 1. Compilando el c´odigo fuente 2 2. Interfaz 5 2.1. Formatoenl´ıneadecomandos . 5 2.2. Uso de MPCOTool como una librer´ıa externa . 6 2.3. Aplicaci´on con interfaz gr´afica de usuario interactiva....... 6 2.4. Ficherosdeentrada.......................... 7 2.4.1. Ficherodeentradaprincipal. 7 2.4.2. Ficherosdeplantilla . 11 2.5. Ficherosdesalida........................... 11 2.5.1. Ficheroderesultados. 11 2.5.2. Ficherodevariables . 11 3. Organizaci´on de MPCOTool 13 4. M´etodos de optimizaci´on 15 4.1. M´etodo de fuerza bruta de barrido regular . 15 4.2. M´etododeMonte-Carlo . 16 4.3. M´etodo de fuerza bruta de muestreo ortogonal . 17 4.4. Algoritmo iterativo aplicado a los m´etodos de fuerza bruta. 18 4.5. M´etododeascensodecolinas . 20 4.5.1. Ascensoporcoordenadas . 21 4.5.2. Ascensoaleatorio. 21 4.6. M´etodogen´etico . 22 4.6.1. Elgenoma........................... 22 4.6.2. Supervivencia de los mejores individuos . 22 4.6.3. Algortimodemutaci´on . 24 4.6.4. Algoritmodereproducci´on . 24 4.6.5. Algoritmodeadaptaci´on. 25 4.6.6. Paralelizaci´on. 25 Referencias 27 1 Cap´ıtulo 1 Compilando el c´odigo fuente El c´odigo fuente en MPCOTool est´aescrito en lenguaje C. El programa ha sido compilado y probado en los siguientes sistemas operativos: Debian Hurd, kFreeBSD y Linux 9; Devuan Linux 2; DragonFly BSD 5.2; Dyson Illumos; Fedora Linux 29; FreeBSD 11.2; Linux Mint DE 3; Manjaro Linux; Microsoft Windows 71, y 101; NetBSD 7.0; OpenBSD 6.4; OpenIndiana Hipster; OpenSUSE Linux Leap; Ubuntu Mate Linux 18.04; y Xubuntu Linux 18.10.
    [Show full text]
  • Mpcotool (The Multi-Purposes Calibration and Optimization Tool): an Open Source Software to Supply Empirical Parameters Required in Simulation Models
    MPCOTool (the Multi-Purposes Calibration and Optimization Tool): an open source software to supply empirical parameters required in simulation models Software authors: J. Burguete and B. Latorre Manual authors: J. Burguete, P. Garc´ıa-Navarro and S. Ambroj April 5, 2017 Contents 1 Building from the source code 2 2 Interface 5 2.1 Commandlineformat ........................ 5 2.2 UsingMPCOToolasanexternallibrary . 6 2.3 Interactive graphical user interface application . ...... 6 2.4 Inputfiles............................... 7 2.4.1 Maininputfile ........................ 7 2.4.2 Templatefiles......................... 10 2.5 Outputfiles.............................. 11 2.5.1 Resultsfile .......................... 11 2.5.2 Variablesfile ......................... 11 3 Organization of MPCOTool 12 4 Optimization methods 14 4.1 Sweepbruteforcemethod . 14 4.2 Monte-Carlomethod . 15 4.3 Iterative algorithm applied to brute force methods . 15 4.4 Directionsearchmethod . 17 4.4.1 Coordinatesdescent . 19 4.4.2 Random............................ 19 4.5 Geneticmethod............................ 19 4.5.1 Thegenome.......................... 19 4.5.2 Survivalofthebestindividuals . 21 4.5.3 Mutationalgorithm . 21 4.5.4 Reproductionalgorithm . 22 4.5.5 Adaptationalgorithm . 22 4.5.6 Parallelization . 23 References 24 1 Chapter 1 Building from the source code The source code in MPCOTool is written in C language. This software has been built and tested in the following operative systems: • Debian Hurd, kFreeBSD and Linux 8; • DragonFly BSD 4.6; • Dyson Illumos; • Fedora Linux 25; • FreeBSD 11.0; • Microsoft Windows 71, 8.11 and 101; • NetBSD 7.0; • OpenBSD 6.0; • OpenIndiana Hipster; • OpenSUSE Tumbleweed; • and Ubuntu Linux 16.10. Probably, this software can be built and it works in other operative systems, software distributions or versions but it has not been tested.
    [Show full text]
  • The Multi-Purposes Calibration and Optimization Tool): an Open Source Software to Supply Empirical Parameters Required in Simulation Models
    MPCOTool (the Multi-Purposes Calibration and Optimization Tool): an open source software to supply empirical parameters required in simulation models Software authors: J. Burguete and B. Latorre Manual authors: J. Burguete, P. Garc´ıa-Navarro and S. Ambroj July 20, 2017 Contents 1 Building from the source code 2 2 Interface 5 2.1 Commandlineformat ........................ 5 2.2 UsingMPCOToolasanexternallibrary . 6 2.3 Interactive graphical user interface application . ...... 6 2.4 Inputfiles............................... 7 2.4.1 Maininputfile ........................ 7 2.4.2 Templatefiles......................... 10 2.5 Outputfiles.............................. 11 2.5.1 Resultsfile .......................... 11 2.5.2 Variablesfile ......................... 11 3 Organization of MPCOTool 12 4 Optimization methods 14 4.1 Sweepbruteforcemethod . 14 4.2 Monte-Carlomethod . 15 4.3 Iterative algorithm applied to brute force methods . 15 4.4 Directionsearchmethod . 17 4.4.1 Coordinatesdescent . 19 4.4.2 Random............................ 19 4.5 Geneticmethod............................ 19 4.5.1 Thegenome.......................... 19 4.5.2 Survivalofthebestindividuals . 21 4.5.3 Mutationalgorithm . 21 4.5.4 Reproductionalgorithm . 22 4.5.5 Adaptationalgorithm . 22 4.5.6 Parallelization . 23 References 24 1 Chapter 1 Building from the source code The source code in MPCOTool is written in C language. This software has been built and tested in the following operative systems: • Debian Hurd, kFreeBSD and Linux 9; • DragonFly BSD 4.8; • Dyson Illumos; • Fedora Linux 26; • FreeBSD 11.0; • Microsoft Windows 71, 8.11 and 101; • NetBSD 7.0; • OpenBSD 6.1; • OpenIndiana Hipster; • OpenSUSE Tumbleweed; • and Ubuntu Linux 17.04. Probably, this software can be built and it works in other operative systems, software distributions or versions but it has not been tested.
    [Show full text]